Skip to content

Get replay

GET
/replays/{groupingProp}/{replayValue}

Retrieve merged metadata and replayable events for recordings sharing a metadata key and value.

Authorizations

Private API Key
Private API Key
Bearer token for authentication. Use your private API key as the token.
or
Presigned URL
Presigned URL
Use a presigned URL generated by the List Replays endpoint with includeSignedUrls=true. Time-constrained and scoped to a single recording, so it can be exposed publicly in your replayer.
Show parameters: TenantId, KeyId, Expires, Signature
TenantId
Your tenant (organisation) identifier. Included automatically in presigned URLs generated by the listing endpoints.
KeyId
The name/label of the signing key configured in your rrweb Cloud account. e.g. "key-2024-12"
Expires
Expiration timestamp (UNIX seconds)
Signature
SHA256 over the constructed string "GET /recordings/{recordingId} {tenantId} {expires}". Please get in contact if you need to calculate this manually.

Parameters

Path Parameters

groupingProp*

The metadata key used to group recordings into replays

Type
string
Required
Example"sessionId"
Min Length
1
Max Length
100
replayValue*

The metadata value identifying this replay group

Type
string
Required
Example"sess-123"
Min Length
1
Max Length
500

Responses

Successfully retrieved replay metadata and events

application/json
JSON
{
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"events": [
  
  
{
  
  
  
"type": 4,
  
  
  
"timestamp": 1234567890,
  
  
  
"data": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"originalTimestamp": 0
  
  
}
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI